<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">











<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <title>Maven FileSync Plugin - filesync:generate</title>
    <style type="text/css" media="all">
      @import url("./css/maven-base.css");
      @import url("./css/maven-theme.css");
      @import url("./css/site.css");
    </style>
    <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
          </head>
  <body class="composite">
    <div id="banner">
                    <span id="bannerLeft">
    
            Maven FileSync Plugin
    
            </span>
                    <div class="clear">
        <hr/>
      </div>
    </div>
    <div id="breadcrumbs">
          
  

  
    
  
  
    
            <div class="xleft">
        Last Published: 2011-05-27
                      </div>
            <div class="xright">      
  

  
    
  
  
    
  </div>
      <div class="clear">
        <hr/>
      </div>
    </div>
    <div id="leftColumn">
      <div id="navcolumn">
           
  

  
    
  
  
    
                   <h5>Overview</h5>
            <ul>
              
    <li class="none">
                    <a href="index.html">Introduction</a>
          </li>
              
    <li class="none">
                    <a href="plugin-info.html">Goals</a>
          </li>
              
    <li class="none">
                    <a href="usage.html">Usage</a>
          </li>
              
    <li class="none">
                    <a href="faq.html">FAQ</a>
          </li>
          </ul>
              <h5>Examples</h5>
            <ul>
              
    <li class="none">
                    <a href="examples/example-one.html">Example with fully defined mapping</a>
          </li>
              
    <li class="none">
                    <a href="examples/example-two.html">Minimal configuration</a>
          </li>
              
    <li class="none">
                    <a href="examples/example-three.html">Command line invocation</a>
          </li>
          </ul>
                                           <a href="http://maven.apache.org/" title="Built by Maven" class="poweredBy">
            <img alt="Built by Maven" src="./images/logos/maven-feather.png"></img>
          </a>
                       
  

  
    
  
  
    
        </div>
    </div>
    <div id="bodyColumn">
      <div id="contentBox">
        <div class="section"><h2><a name="filesync:generate"></a>filesync:generate</h2>
<p><strong>Full name</strong>:</p>
<p>com.googlecode.mavenfilesync:maven-filesync-plugin:1.0.0-SNAPSHOT:generate</p>
<p><strong>Description</strong>:</p>
<div>Generates configuration files
(.settings/de.loskutov.FileSync.prefs) and adds FileSync project
nature to the project (.project file). Does not refresh project in
eclipse workspace - a manual refresh is needed. If run from within</div><p><strong>Attributes</strong>:</p>
<ul><li>Requires a Maven 2.0 project to be executed.</li>
<li>Binds by default to the lifecycle phase: <code>initialize</code>.</li>
</ul>
<div class="section"><h3><a name="Required_Parameters"></a>Required Parameters</h3>
<table class="bodyTable"><tr class="a"><th>Name</th>
<th>Type</th>
<th>Since</th>
<th>Description</th>
</tr>
<tr class="b"><td><strong><a href="#projectDirectory">projectDirectory</a></strong></td>
<td><code>File</code></td>
<td><code>-</code></td>
<td>Project base dir. Defaults to ${project.basedir}.<br />
</td>
</tr>
</table>
</div>
<div class="section"><h3><a name="Optional_Parameters"></a>Optional Parameters</h3>
<table class="bodyTable"><tr class="a"><th>Name</th>
<th>Type</th>
<th>Since</th>
<th>Description</th>
</tr>
<tr class="b"><td><strong><a href="#defaultDestination">defaultDestination</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>Directory where files will be copied by default (if no specific
location is given for a mapping).<br />
</td>
</tr>
<tr class="a"><td><strong><a href="#defaultVariables">defaultVariables</a></strong></td>
<td><code>String</code></td>
<td><code>-</code></td>
<td>Path to variables substitution file, relative to the project
directory. Contains variables in java properties format i.e.
property=value.<br />
</td>
</tr>
<tr class="b"><td><strong><a href="#includeTeamPrivateFiles">includeTeamPrivateFiles</a></strong></td>
<td><code>boolean</code></td>
<td><code>-</code></td>
<td>If <code>true</code> then source management files (e.g. .svn
directories) will be synchronized too. Default value is
<code>false</code>.<br />
<strong>Default value is</strong>: <code>false</code>.</td>
</tr>
<tr class="a"><td><strong><a href="#mappings">mappings</a></strong></td>
<td><code>FileSyncMapping[]</code></td>
<td><code>-</code></td>
<td>Multiple mappings can be defined - each one defines at least source
directory (from there the files will be copied). If no
defaultDirectory given, the mapping must also define the target
directory (the destination where the files will be synchronized). 

<pre><code>&lt;mappings&gt;
        &lt;mapping&gt;
            &lt;sourceFolder&gt;source folder relative to project root&lt;/sourceFolder&gt;
            &lt;destinationFolder&gt;System absolute path or workspace absolute path if preceded by :/&lt;/destinationFolder&gt;
            &lt;inclPatternList&gt;
                &lt;include&gt;project root relative path or a path pattern in the Ant path notation&lt;/include&gt;
                &lt;include&gt;another include&lt;/include&gt;
            &lt;include&gt;C*&lt;/include&gt;
            &lt;/inclPatternList&gt;
            &lt;exclPatternList&gt;
                &lt;exclude&gt;project root relative path or a path pattern in the Ant path notation&lt;/exclude&gt;
            &lt;/exclPatternList&gt;
            &lt;variablesFile&gt;relative path to variables file&lt;/variablesFile&gt;
        &lt;/mapping&gt;
    &lt;/mappings&gt;
</code></pre><br />
</td>
</tr>
<tr class="b"><td><strong><a href="#override">override</a></strong></td>
<td><code>boolean</code></td>
<td><code>-</code></td>
<td>Set override to <code>false</code> if the settings file should not
be overriden.<br />
<strong>Default value is</strong>: <code>true</code>.</td>
</tr>
<tr class="a"><td><strong><a href="#skip">skip</a></strong></td>
<td><code>boolean</code></td>
<td><code>-</code></td>
<td>Set skip to <code>true</code> to skip execution<br />
</td>
</tr>
<tr class="b"><td><strong><a href="#useCurrentDateForDestinationFiles">useCurrentDateForDestinationFiles</a></strong></td>
<td><code>boolean</code></td>
<td><code>-</code></td>
<td>If <code>true</code> the destination files creation date will be
set to the date when the synchronization took place.<br />
<strong>Default value is</strong>: <code>false</code>.</td>
</tr>
</table>
</div>
<div class="section"><h3><a name="Parameter_Details"></a>Parameter Details</h3>
<p><strong><a name="defaultDestination">defaultDestination</a>:</strong></p>
<div>Directory where files will be copied by default (if no specific
location is given for a mapping).</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
</ul>
<hr />
<p><strong><a name="defaultVariables">defaultVariables</a>:</strong></p>
<div>Path to variables substitution file, relative to the project
directory. Contains variables in java properties format i.e.
property=value.</div><ul><li><strong>Type</strong>: <code>java.lang.String</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${generate.defaultVariables}</code></li>
</ul>
<hr />
<p><strong><a name="includeTeamPrivateFiles">includeTeamPrivateFiles</a>:</strong></p>
<div>If <code>true</code> then source management files (e.g. .svn
directories) will be synchronized too. Default value is
<code>false</code>.</div><ul><li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${generate.includeTeamPrivateFiles}</code></li>
<li><strong>Default</strong>: <code>false</code></li>
</ul>
<hr />
<p><strong><a name="mappings">mappings</a>:</strong></p>
<div>Multiple mappings can be defined - each one defines at least source
directory (from there the files will be copied). If no
defaultDirectory given, the mapping must also define the target
directory (the destination where the files will be synchronized). 

<pre><code>&lt;mappings&gt;
        &lt;mapping&gt;
            &lt;sourceFolder&gt;source folder relative to project root&lt;/sourceFolder&gt;
            &lt;destinationFolder&gt;System absolute path or workspace absolute path if preceded by :/&lt;/destinationFolder&gt;
            &lt;inclPatternList&gt;
                &lt;include&gt;project root relative path or a path pattern in the Ant path notation&lt;/include&gt;
                &lt;include&gt;another include&lt;/include&gt;
            &lt;include&gt;C*&lt;/include&gt;
            &lt;/inclPatternList&gt;
            &lt;exclPatternList&gt;
                &lt;exclude&gt;project root relative path or a path pattern in the Ant path notation&lt;/exclude&gt;
            &lt;/exclPatternList&gt;
            &lt;variablesFile&gt;relative path to variables file&lt;/variablesFile&gt;
        &lt;/mapping&gt;
    &lt;/mappings&gt;
</code></pre></div><ul><li><strong>Type</strong>: <code>com.googlecode.mavenfilesync.FileSyncMapping[]</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${generate.mappings}</code></li>
</ul>
<hr />
<p><strong><a name="override">override</a>:</strong></p>
<div>Set override to <code>false</code> if the settings file should not
be overriden.</div><ul><li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${generate.override}</code></li>
<li><strong>Default</strong>: <code>true</code></li>
</ul>
<hr />
<p><strong><a name="projectDirectory">projectDirectory</a>:</strong></p>
<div>Project base dir. Defaults to ${project.basedir}.</div><ul><li><strong>Type</strong>: <code>java.io.File</code></li>
<li><strong>Required</strong>: <code>Yes</code></li>
<li><strong>Expression</strong>: <code>${project.basedir}</code></li>
</ul>
<hr />
<p><strong><a name="skip">skip</a>:</strong></p>
<div>Set skip to <code>true</code> to skip execution</div><ul><li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Expression</strong>: <code>${skip} default-value=</code></li>
</ul>
<hr />
<p><strong><a name="useCurrentDateForDestinationFiles">useCurrentDateForDestinationFiles</a>:</strong></p>
<div>If <code>true</code> the destination files creation date will be
set to the date when the synchronization took place.</div><ul><li><strong>Type</strong>: <code>boolean</code></li>
<li><strong>Required</strong>: <code>No</code></li>
<li><strong>Default</strong>: <code>false</code></li>
</ul>
</div>
</div>

      </div>
    </div>
    <div class="clear">
      <hr/>
    </div>
    <div id="footer">
      <div class="xright">&#169;  
          2011
    
          
  

  
    
  
  
    
  </div>
      <div class="clear">
        <hr/>
      </div>
    </div>
  </body>
</html>
